GET Attachments?assetId={assetId}&includeContent={includeContent}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves attachments for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
includeContent |
Include the file contents of the attachments |
boolean |
Default value is False |
take |
Number of attachments to retrieve. Default is all attachments |
integer |
None. |
skip |
Number of attachments to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the attachments before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of attachments.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Attachment |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "AttachmentId": "27a7ee78-5490-4264-9b6f-2f6ad3ca1f7f", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "6d96e6ae-914b-4fa4-8449-1d009781fb08", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "45bcef5e-f624-41c2-8ae2-a30748dadf8d", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "834b54e9-9524-4ef2-8219-f8edc62b7d08", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "f32c6bea-30b3-4932-affa-923423ed31a6", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6e851bee-a974-40c7-b264-e7faf13d7abc", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "b02cd158-1faa-44a3-b082-f036fbce84e2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T23:10:33.768607-07:00", "MeasurementValueNeededDate": "2024-04-28T23:10:33.768607-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e6e3d0a6-c7c1-4ed9-b0de-a29705b0e856", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "75e390d2-8488-46e5-925d-d58b943c4e35", "EffectiveDate": "2024-04-28T23:10:33.768607-07:00", "StateType": { "StateTypeId": "a4731c3a-7c7c-4bce-8d92-6b377a4ae40e", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "f32c6bea-30b3-4932-affa-923423ed31a6", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6e851bee-a974-40c7-b264-e7faf13d7abc", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "18cddf2e-27c0-475b-932c-4c55944e1052", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "5394692c-9c43-4eaf-bfb7-3614a9c85bf0", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "dbf9d53c-ccc4-4eb3-b5ff-11784e36b4c7", "EffectiveDate": "2024-04-28T23:10:33.768607-07:00", "StatusType": { "StatusTypeId": "d4b78163-af7d-4784-8b6b-48b1a26825f2", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "f32c6bea-30b3-4932-affa-923423ed31a6", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6e851bee-a974-40c7-b264-e7faf13d7abc", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "09d424b2-1cab-4a10-a3e0-6838148a53f1", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "b5b9c4fd-a318-49e7-aa5f-e091f1323eb5", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "2cefe1bd-e586-4d50-bd69-21cb0557ec1a", "EffectiveDate": "2024-04-28T23:10:33.768607-07:00", "WellPurposeType": { "WellPurposeTypeId": "43c2e033-9e08-4855-94ce-dbeff2b37533", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d2713c00-ee59-4288-aa51-2d6506e46a2e", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "3ba58092-ff9d-43a5-8311-27652bad4510", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T23:10:33.768607-07:00", "MeasurementValueNeededDate": "2024-04-28T23:10:33.768607-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "be504bff-0782-4dae-85e3-54080fa5d177", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2024-04-28T23:10:33.768607-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "0159d48b-a13d-4360-a3e3-7297f1213e6c", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 7" }, { "AttachmentId": "27a7ee78-5490-4264-9b6f-2f6ad3ca1f7f", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "6d96e6ae-914b-4fa4-8449-1d009781fb08", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "45bcef5e-f624-41c2-8ae2-a30748dadf8d", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "834b54e9-9524-4ef2-8219-f8edc62b7d08", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "f32c6bea-30b3-4932-affa-923423ed31a6", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6e851bee-a974-40c7-b264-e7faf13d7abc", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "b02cd158-1faa-44a3-b082-f036fbce84e2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T23:10:33.768607-07:00", "MeasurementValueNeededDate": "2024-04-28T23:10:33.768607-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e6e3d0a6-c7c1-4ed9-b0de-a29705b0e856", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "75e390d2-8488-46e5-925d-d58b943c4e35", "EffectiveDate": "2024-04-28T23:10:33.768607-07:00", "StateType": { "StateTypeId": "a4731c3a-7c7c-4bce-8d92-6b377a4ae40e", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "f32c6bea-30b3-4932-affa-923423ed31a6", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6e851bee-a974-40c7-b264-e7faf13d7abc", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "18cddf2e-27c0-475b-932c-4c55944e1052", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "5394692c-9c43-4eaf-bfb7-3614a9c85bf0", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "dbf9d53c-ccc4-4eb3-b5ff-11784e36b4c7", "EffectiveDate": "2024-04-28T23:10:33.768607-07:00", "StatusType": { "StatusTypeId": "d4b78163-af7d-4784-8b6b-48b1a26825f2", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "f32c6bea-30b3-4932-affa-923423ed31a6", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6e851bee-a974-40c7-b264-e7faf13d7abc", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "09d424b2-1cab-4a10-a3e0-6838148a53f1", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "b5b9c4fd-a318-49e7-aa5f-e091f1323eb5", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "2cefe1bd-e586-4d50-bd69-21cb0557ec1a", "EffectiveDate": "2024-04-28T23:10:33.768607-07:00", "WellPurposeType": { "WellPurposeTypeId": "43c2e033-9e08-4855-94ce-dbeff2b37533", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d2713c00-ee59-4288-aa51-2d6506e46a2e", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "3ba58092-ff9d-43a5-8311-27652bad4510", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T23:10:33.768607-07:00", "MeasurementValueNeededDate": "2024-04-28T23:10:33.768607-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "be504bff-0782-4dae-85e3-54080fa5d177", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2024-04-28T23:10:33.768607-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "0159d48b-a13d-4360-a3e3-7297f1213e6c", "CreateDate": "2024-04-28T23:10:33.768607-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T23:10:33.768607-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }